Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ExplicitImports.jl test #1875

Merged
merged 6 commits into from
Mar 21, 2024

Conversation

JoshuaLampert
Copy link
Member

This adds a test using ExplicitImports.jl to check whether we have unused explicit imports or any implicit imports. It also includes the necessary changes to make the test pass.

Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Only one place where imho a second set of eyes necessary, but then it can imho be merged

src/auxiliary/auxiliary.jl Outdated Show resolved Hide resolved
test/test_aqua.jl Outdated Show resolved Hide resolved
Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.48%. Comparing base (2dfde7f) to head (3bb2ffa).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1875      +/-   ##
==========================================
- Coverage   96.30%   89.48%   -6.82%     
==========================================
  Files         439      439              
  Lines       35749    35738      -11     
==========================================
- Hits        34428    31979    -2449     
- Misses       1321     3759    +2438     
Flag Coverage Δ
unittests 89.48% <ø> (-6.82%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JoshuaLampert
Copy link
Member Author

Codecov seems to be down for some reason. And then there are the known t8code issues again.

@JoshuaLampert
Copy link
Member Author

Closing and reopening this PR to trigger CI again (I don't have the rights to rerun the jobs without closing and opening).

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@JoshuaLampert JoshuaLampert requested a review from sloede March 19, 2024 10:11
@sloede sloede enabled auto-merge (squash) March 21, 2024 15:47
@JoshuaLampert
Copy link
Member Author

Codecov is down again...

@ranocha ranocha disabled auto-merge March 21, 2024 18:55
@ranocha ranocha merged commit 18aaae9 into trixi-framework:main Mar 21, 2024
21 of 33 checks passed
@JoshuaLampert JoshuaLampert deleted the explicitimports branch March 21, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants